<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">

<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>SHORTSTACK ISI TYPES</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>

<!--  Generated by Natural Docs, version 1.52 -->
<!--  http://www.naturaldocs.org  -->

<!-- saved from url=(0026)http://www.naturaldocs.org -->




<div id=Content><div class="CSection"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="SHORTSTACK_ISI_TYPES"></a>SHORTSTACK ISI TYPES</h1><div class=CBody><p>Definitions of the enumerations and data types required by the Interoperable Self-Installation (ISI) portion of the ShortStack LonTalk Compact API.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#SHORTSTACK_ISI_TYPES" >SHORTSTACK ISI TYPES</a></td><td class=SDescription>Definitions of the enumerations and data types required by the Interoperable Self-Installation (ISI) portion of the ShortStack LonTalk Compact API.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Enumerations_and_Types" >Enumerations and Types</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#IsiEvent" >IsiEvent</a></td><td class=SDescription>Enumeration for different event types.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#IsiType" >IsiType</a></td><td class=SDescription>Enumeration for different engine types.</td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#IsiStartFlags" >IsiStartFlags</a></td><td class=SDescription>Enumeration for option flags used while starting the ISI engine.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#IsiDirection" >IsiDirection</a></td><td class=SDescription>Enumeration for the direction of a network variable in a connection.</td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#IsiScope" >IsiScope</a></td><td class=SDescription>Enumeration for scope of a connection message.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#IsiConnectionId" >IsiConnectionId</a></td><td class=SDescription>Structure representing the unique connection ID.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#IsiConnectionHeader" >IsiConnectionHeader</a></td><td class=SDescription>Structure representing the connection header.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#IsiConnection" >IsiConnection</a></td><td class=SDescription>Structure representing a row in the connection table.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#IsiCsmoData" >IsiCsmoData</a></td><td class=SDescription>Structure representing the CSMO message.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#IsiDownlinkRpcCode" >IsiDownlinkRpcCode</a></td><td class=SDescription>Codes for downlink calls from the host to the Micro Server.</td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#IsiUplinkRpcCode" >IsiUplinkRpcCode</a></td><td class=SDescription>Codes for uplink callbacks from the Micro Server to the host.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#IsiRpcMessage" >IsiRpcMessage</a></td><td class=SDescription>Structure defining the data format in the RPC messages between the host and the Micro Server.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Enumerations_and_Types"></a>Enumerations and Types</h3></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="IsiEvent"></a>IsiEvent</h3><div class=CBody><p>Enumeration for different event types.</p><p>This enumeration represents the possible events that are passed to the host when the ISI engine does a callback.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="IsiType"></a>IsiType</h3><div class=CBody><p>Enumeration for different engine types.</p><p>This enumeration specifies the ISI protocol to be implemented by the ISI engine.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="IsiStartFlags"></a>IsiStartFlags</h3><div class=CBody><p>Enumeration for option flags used while starting the ISI engine.</p><p>This enumeration represents option flags for the <a href="ShortStackIsiApi-h.html#IsiStart" class=LFunction id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">IsiStart</a> function used to start the ISI engine.&nbsp; Use a combination of these flags with the <a href="ShortStackIsiApi-h.html#IsiStart" class=LFunction id=link2 onMouseOver="ShowTip(event, 'tt1', 'link2')" onMouseOut="HideTip('tt1')">IsiStart</a> function.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="IsiDirection"></a>IsiDirection</h3><div class=CBody><p>Enumeration for the direction of a network variable in a connection.</p><p>This enumeration represents the direction of the network variable on offer in a CSMO.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="IsiScope"></a>IsiScope</h3><div class=CBody><p>Enumeration for scope of a connection message.</p><p>This enumeration represents the different values that can be used in the scope field of a CSMO message.&nbsp; This value represents the scope of the resource file containing the functional profile and network variable type definitions specified by the Profile and NvType fields.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="IsiConnectionId"></a>IsiConnectionId</h3><div class=CBody><p>Structure representing the unique connection ID.</p><p>This structure contains the unique connection ID for a connection.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="IsiConnectionHeader"></a>IsiConnectionHeader</h3><div class=CBody><p>Structure representing the connection header.</p><p>Following the ISI Message Header, all connection-related messages start with this structure.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="IsiConnection"></a>IsiConnection</h3><div class=CBody><p>Structure representing a row in the connection table.</p><p>This structure is used to represent a row in the connection table that is returned by <a href="ShortStackIsiApi-h.html#IsiGetConnection" class=LFunction id=link3 onMouseOver="ShowTip(event, 'tt2', 'link3')" onMouseOut="HideTip('tt2')">IsiGetConnection</a> and is used in <a href="ShortStackIsiApi-h.html#IsiSetConnection" class=LFunction id=link4 onMouseOver="ShowTip(event, 'tt3', 'link4')" onMouseOut="HideTip('tt3')">IsiSetConnection</a> to set a row in the table.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="IsiCsmoData"></a>IsiCsmoData</h3><div class=CBody><p>Structure representing the CSMO message.</p><p>This structure contains the fields of a CSMO message to be sent by the ISI engine.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="IsiDownlinkRpcCode"></a>IsiDownlinkRpcCode</h3><div class=CBody><p>Codes for downlink calls from the host to the Micro Server.</p><p>These are the function identifiers for downlink API calls.&nbsp; Numbers are assigned explicitly just to indicate the import of maintaining certain number values as these must be consistent with the Micro Server&rsquo;s implementation.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="IsiUplinkRpcCode"></a>IsiUplinkRpcCode</h3><div class=CBody><p>Codes for uplink callbacks from the Micro Server to the host.</p><p>These are the callback identifiers for uplink API calls.&nbsp; Numbers are assigned explicitly just to indicate the import of maintaining certain number values as these must be consistent with the Micro Server&rsquo;s implementation.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="IsiRpcMessage"></a>IsiRpcMessage</h3><div class=CBody><p>Structure defining the data format in the RPC messages between the host and the Micro Server.</p><p>This structure defines the format of the data in the ISI remote procedure call messages.</p></div></div></div>

</div><!--Content-->


<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->


<div id=Menu><div class=MEntry><div class=MFile><a href="ldv-h.html">ldv.h</a></div></div><div class=MEntry><div class=MFile><a href="LonPlatform-h.html">LonPlatform.h</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackApi-h.html">SHORTSTACK API</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackIsiApi-h.html">SHORTSTACK ISI API</a></div></div><div class=MEntry><div class=MFile id=MSelected>SHORTSTACK ISI TYPES</div></div><div class=MEntry><div class=MFile><a href="ShortStackTypes-h.html">SHORTSTACK TYPES</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackApi-c.html">ShortStackApi.c</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackHandlers-c.html">ShortStackHandlers.c</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackIsiApi-c.html">ShortStackIsiApi.c</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackIsiHandlers-c.html">ShortStackIsiHandlers.c</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Index</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Macros.html">Macros</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Types.html">Types</a></div></div></div></div></div><script type="text/javascript"><!--
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option  id=MSearchEverything selected value="General">Everything</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Macros">Macros</option><option value="Types">Types</option></select></div></div><!--Menu-->



<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>extern const LonApiError IsiStart(</td><td class="PType  prettyprint " nowrap>IsiType&nbsp;</td><td class="PParameter  prettyprint " nowrap>type,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>IsiStartFlags&nbsp;</td><td class="PParameter  prettyprint " nowrap>flags</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Starts the ISI engine.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>extern IsiConnection* IsiGetConnection(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>index</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns a pointer to an entry in the connection table.</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>extern void IsiSetConnection(</td><td class="PType  prettyprint " nowrap>IsiConnection&nbsp;</td><td class="PParameterPrefix  prettyprint " nowrap>*</td><td class="PParameter  prettyprint " nowrap>pConnection,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameterPrefix  prettyprint " nowrap></td><td class="PParameter  prettyprint " nowrap>index</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Updates an entry in the connection table.</div></div><!--END_ND_TOOLTIPS-->




<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>


<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>